Skip to content

feat: Dialog API documentation #621

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 10 commits into from
Aug 8, 2025
Merged

feat: Dialog API documentation #621

merged 10 commits into from
Aug 8, 2025

Conversation

Strokkur424
Copy link
Member

No description provided.

@github-actions GitHub Actions
Copy link

github-actions bot commented Jul 10, 2025 •
edited
Loading

built with Refined Cloudflare Pages Action

⚡ Cloudflare Pages Deployment

Name Status Preview Last Commit
papermc-docs ✅ Ready (View Log) Visit Preview fecc8f4

mbax
mbax reviewed Jul 12, 2025
View reviewed changes
mbax
mbax reviewed Jul 12, 2025
View reviewed changes
mbax
mbax reviewed Jul 12, 2025
View reviewed changes
mbax
mbax reviewed Jul 12, 2025
View reviewed changes
Machine-Maker
Machine-Maker requested changes Jul 16, 2025
View reviewed changes
Lulu13022002
Lulu13022002 reviewed Jul 29, 2025
View reviewed changes
Emilxyz
Emilxyz reviewed Aug 4, 2025
View reviewed changes
@Strokkur424 Strokkur424 added the dev guide This issue or PR aims to introduce developer API documentation label Aug 5, 2025
Lulu13022002
Lulu13022002 reviewed Aug 5, 2025
View reviewed changes
@Machine-Maker
Copy link
Member

Lets also document the behavior of Audience#closeDialog. It's got some quirks with how it behaves afaik.

@Strokkur424
Copy link
Member Author

I did give a try at documenting the closeDialogs, but I couldn't really figure out the weird quirks. It just worked basically exactly as I would expect, but in normal gameplay and during the config phase. If you have something specific in mind, I would appreciate a follow-up message.

@Strokkur424
Copy link
Member Author

I am merging this so that we have something to link to people instead of always just linking the preview. If there are any further issues with it, fixup PRs can always be made.

@Strokkur424 Strokkur424 merged commit ba2d5be into PaperMC:main Aug 8, 2025
3 checks passed
@Strokkur424 Strokkur424 deleted the feat/dialogs branch August 8, 2025 19:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mbax mbax mbax left review comments

@Lulu13022002 Lulu13022002 Lulu13022002 left review comments

@Machine-Maker Machine-Maker Machine-Maker requested changes

+1 more reviewer

@Emilxyz Emilxyz Emilxyz left review comments

Reviewers whose approvals may not affect merge requirements
Assignees

@Strokkur424 Strokkur424

Labels
dev guide This issue or PR aims to introduce developer API documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@Strokkur424 @Machine-Maker @mbax @Emilxyz @Lulu13022002